Skip to main content

Get Corporate List

GET : http://<base_url>/digipay/v3/user/corporate

This API is used to get corporate data list into the system.

QUERY PARAMS:-

ParameterTypeDescriptionValue
is_activeBooleanif value is true it will show active languages in response, if value is false it will show inActive langauages in responsetrue/false
skipIntSkip the first n document from the query result2
limitIntLimits the number of records or documents that you want1
start_dateLongunix timestamp value in second1
end_dateLongunix timestamp value in second1
sortingStringSorting of the Data in the form of a string123
search_keywordStringa keyword which can be either name of language or a language code to get desired language as output123

HEADERS:-

ParameterTypeDescriptionValue
AuthorizationStringIt is a combination of type and token to authenticate user for the given tokenToken duik7309njdlkhdauhknksadhjkas986876sd873j
CompanyIDStringCompany_id is a unique primary id, that is represent company detail76bc712200ca444fa334f9e55e5fd7a8

Request Body:-

Request Example
curl --request GET \
--url 'http://192.168.1.102:8014/digipay/v3/user/corporate?is_active=false&skip=1&limit=1&start_date=1&end_date=1&sorting=123&serach_keyword=123' \
--header 'Authorization: Token duik7309njdlkhdauhknksadhjkas986876sd873j' \
--header 'CompanyID: 7753ad6bd8cf48f5b1312fd21eb36588' \
--header 'accept: application/json'

Response:-

Response 200(OK)

{
"success": 1,
"error": [],
"data": {
"corporate": {
"id": "b9a4cbeeedd340509cb1ac628cae2973",
"user_id": "1",
"corporate_name": "Digipay",
"image": "https//image.png",
"phone_number": "89323235",
"dial_code": "+91",
"email": "abc@gmail.com",
"website_url": "www.com",
"is_active": true,
"created_date": 1658894024,
"country_id": "123"
}
}
}
Response 400(BAD REQUEST)
{
"success": 0,
"error"": [1],
"data": {
"message": "BAD_REQUEST",
}
}

RESPONSES :-

Status CodeDescription
200OK
400BAD REQUEST
404NOT FOUND
500INTERNAL SERVER ERROR